<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Copyright (C) 2007 The Guava Authors<a name="line.2"></a>
<span class="sourceLineNo">003</span> *<a name="line.3"></a>
<span class="sourceLineNo">004</span> * Licensed under the Apache License, Version 2.0 (the "License");<a name="line.4"></a>
<span class="sourceLineNo">005</span> * you may not use this file except in compliance with the License.<a name="line.5"></a>
<span class="sourceLineNo">006</span> * You may obtain a copy of the License at<a name="line.6"></a>
<span class="sourceLineNo">007</span> *<a name="line.7"></a>
<span class="sourceLineNo">008</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * Unless required by applicable law or agreed to in writing, software<a name="line.10"></a>
<span class="sourceLineNo">011</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.11"></a>
<span class="sourceLineNo">012</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.12"></a>
<span class="sourceLineNo">013</span> * See the License for the specific language governing permissions and<a name="line.13"></a>
<span class="sourceLineNo">014</span> * limitations under the License.<a name="line.14"></a>
<span class="sourceLineNo">015</span> */<a name="line.15"></a>
<span class="sourceLineNo">016</span><a name="line.16"></a>
<span class="sourceLineNo">017</span>package com.google.common.collect;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import com.google.common.annotations.GwtCompatible;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.util.Collection;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.List;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.Map;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.Set;<a name="line.24"></a>
<span class="sourceLineNo">025</span><a name="line.25"></a>
<span class="sourceLineNo">026</span>import javax.annotation.Nullable;<a name="line.26"></a>
<span class="sourceLineNo">027</span><a name="line.27"></a>
<span class="sourceLineNo">028</span>/**<a name="line.28"></a>
<span class="sourceLineNo">029</span> * A collection that maps keys to values, similar to {@link Map}, but in which<a name="line.29"></a>
<span class="sourceLineNo">030</span> * each key may be associated with &lt;i&gt;multiple&lt;/i&gt; values. You can visualize the<a name="line.30"></a>
<span class="sourceLineNo">031</span> * contents of a multimap either as a map from keys to &lt;i&gt;nonempty&lt;/i&gt;<a name="line.31"></a>
<span class="sourceLineNo">032</span> * collections of values:<a name="line.32"></a>
<span class="sourceLineNo">033</span> *<a name="line.33"></a>
<span class="sourceLineNo">034</span> * &lt;ul&gt;<a name="line.34"></a>
<span class="sourceLineNo">035</span> * &lt;li&gt;a → 1, 2<a name="line.35"></a>
<span class="sourceLineNo">036</span> * &lt;li&gt;b → 3<a name="line.36"></a>
<span class="sourceLineNo">037</span> * &lt;/ul&gt;<a name="line.37"></a>
<span class="sourceLineNo">038</span> *<a name="line.38"></a>
<span class="sourceLineNo">039</span> * ... or as a single "flattened" collection of key-value pairs:<a name="line.39"></a>
<span class="sourceLineNo">040</span> *<a name="line.40"></a>
<span class="sourceLineNo">041</span> * &lt;ul&gt;<a name="line.41"></a>
<span class="sourceLineNo">042</span> * &lt;li&gt;a → 1<a name="line.42"></a>
<span class="sourceLineNo">043</span> * &lt;li&gt;a → 2<a name="line.43"></a>
<span class="sourceLineNo">044</span> * &lt;li&gt;b → 3<a name="line.44"></a>
<span class="sourceLineNo">045</span> * &lt;/ul&gt;<a name="line.45"></a>
<span class="sourceLineNo">046</span> *<a name="line.46"></a>
<span class="sourceLineNo">047</span> * &lt;p&gt;&lt;b&gt;Important:&lt;/b&gt; although the first interpretation resembles how most<a name="line.47"></a>
<span class="sourceLineNo">048</span> * multimaps are &lt;i&gt;implemented&lt;/i&gt;, the design of the {@code Multimap} API is<a name="line.48"></a>
<span class="sourceLineNo">049</span> * based on the &lt;i&gt;second&lt;/i&gt; form. So, using the multimap shown above as an<a name="line.49"></a>
<span class="sourceLineNo">050</span> * example, the {@link #size} is {@code 3}, not {@code 2}, and the {@link<a name="line.50"></a>
<span class="sourceLineNo">051</span> * #values} collection is {@code [1, 2, 3]}, not {@code [[1, 2], [3]]}. For<a name="line.51"></a>
<span class="sourceLineNo">052</span> * those times when the first style is more useful, use the multimap's {@link<a name="line.52"></a>
<span class="sourceLineNo">053</span> * #asMap} view (or create a {@code Map&lt;K, Collection&lt;V&gt;&gt;} in the first place).<a name="line.53"></a>
<span class="sourceLineNo">054</span> *<a name="line.54"></a>
<span class="sourceLineNo">055</span> * &lt;h3&gt;Example&lt;/h3&gt;<a name="line.55"></a>
<span class="sourceLineNo">056</span> *<a name="line.56"></a>
<span class="sourceLineNo">057</span> * &lt;p&gt;The following code: &lt;pre&gt;   {@code<a name="line.57"></a>
<span class="sourceLineNo">058</span> *<a name="line.58"></a>
<span class="sourceLineNo">059</span> *   ListMultimap&lt;String, String&gt; multimap = ArrayListMultimap.create();<a name="line.59"></a>
<span class="sourceLineNo">060</span> *   for (President pres : US_PRESIDENTS_IN_ORDER) {<a name="line.60"></a>
<span class="sourceLineNo">061</span> *     multimap.put(pres.firstName(), pres.lastName());<a name="line.61"></a>
<span class="sourceLineNo">062</span> *   }<a name="line.62"></a>
<span class="sourceLineNo">063</span> *   for (String firstName : multimap.keySet()) {<a name="line.63"></a>
<span class="sourceLineNo">064</span> *     List&lt;String&gt; lastNames = multimap.get(firstName);<a name="line.64"></a>
<span class="sourceLineNo">065</span> *     out.println(firstName + ": " + lastNames);<a name="line.65"></a>
<span class="sourceLineNo">066</span> *   }}&lt;/pre&gt;<a name="line.66"></a>
<span class="sourceLineNo">067</span> *<a name="line.67"></a>
<span class="sourceLineNo">068</span> * ... produces output such as: &lt;pre&gt;   {@code<a name="line.68"></a>
<span class="sourceLineNo">069</span> *<a name="line.69"></a>
<span class="sourceLineNo">070</span> *   Zachary: [Taylor]<a name="line.70"></a>
<span class="sourceLineNo">071</span> *   John: [Adams, Adams, Tyler, Kennedy]<a name="line.71"></a>
<span class="sourceLineNo">072</span> *   George: [Washington, Bush, Bush]<a name="line.72"></a>
<span class="sourceLineNo">073</span> *   Grover: [Cleveland]<a name="line.73"></a>
<span class="sourceLineNo">074</span> *   ...}&lt;/pre&gt;<a name="line.74"></a>
<span class="sourceLineNo">075</span> *<a name="line.75"></a>
<span class="sourceLineNo">076</span> * &lt;h3&gt;Views&lt;/h3&gt;<a name="line.76"></a>
<span class="sourceLineNo">077</span> *<a name="line.77"></a>
<span class="sourceLineNo">078</span> * &lt;p&gt;Much of the power of the multimap API comes from the &lt;i&gt;view<a name="line.78"></a>
<span class="sourceLineNo">079</span> * collections&lt;/i&gt; it provides. These always reflect the latest state of the<a name="line.79"></a>
<span class="sourceLineNo">080</span> * multimap itself. When they support modification, the changes are<a name="line.80"></a>
<span class="sourceLineNo">081</span> * &lt;i&gt;write-through&lt;/i&gt; (they automatically update the backing multimap). These<a name="line.81"></a>
<span class="sourceLineNo">082</span> * view collections are:<a name="line.82"></a>
<span class="sourceLineNo">083</span> *<a name="line.83"></a>
<span class="sourceLineNo">084</span> * &lt;ul&gt;<a name="line.84"></a>
<span class="sourceLineNo">085</span> * &lt;li&gt;{@link #asMap}, mentioned above&lt;/li&gt;<a name="line.85"></a>
<span class="sourceLineNo">086</span> * &lt;li&gt;{@link #keys}, {@link #keySet}, {@link #values}, {@link #entries}, which<a name="line.86"></a>
<span class="sourceLineNo">087</span> *     are similar to the corresponding view collections of {@link Map}<a name="line.87"></a>
<span class="sourceLineNo">088</span> * &lt;li&gt;and, notably, even the collection returned by {@link #get get(key)} is an<a name="line.88"></a>
<span class="sourceLineNo">089</span> *     active view of the values corresponding to {@code key}<a name="line.89"></a>
<span class="sourceLineNo">090</span> * &lt;/ul&gt;<a name="line.90"></a>
<span class="sourceLineNo">091</span> *<a name="line.91"></a>
<span class="sourceLineNo">092</span> * &lt;p&gt;The collections returned by the {@link #replaceValues replaceValues} and<a name="line.92"></a>
<span class="sourceLineNo">093</span> * {@link #removeAll removeAll} methods, which contain values that have just<a name="line.93"></a>
<span class="sourceLineNo">094</span> * been removed from the multimap, are naturally &lt;i&gt;not&lt;/i&gt; views.<a name="line.94"></a>
<span class="sourceLineNo">095</span> *<a name="line.95"></a>
<span class="sourceLineNo">096</span> * &lt;h3&gt;Subinterfaces&lt;/h3&gt;<a name="line.96"></a>
<span class="sourceLineNo">097</span> *<a name="line.97"></a>
<span class="sourceLineNo">098</span> * &lt;p&gt;Instead of using the {@code Multimap} interface directly, prefer the<a name="line.98"></a>
<span class="sourceLineNo">099</span> * subinterfaces {@link ListMultimap} and {@link SetMultimap}. These take their<a name="line.99"></a>
<span class="sourceLineNo">100</span> * names from the fact that the collections they return from {@code get} behave<a name="line.100"></a>
<span class="sourceLineNo">101</span> * like (and, of course, implement) {@link List} and {@link Set}, respectively.<a name="line.101"></a>
<span class="sourceLineNo">102</span> *<a name="line.102"></a>
<span class="sourceLineNo">103</span> * &lt;p&gt;For example, the "presidents" code snippet above used a {@code<a name="line.103"></a>
<span class="sourceLineNo">104</span> * ListMultimap}; if it had used a {@code SetMultimap} instead, two presidents<a name="line.104"></a>
<span class="sourceLineNo">105</span> * would have vanished, and last names might or might not appear in<a name="line.105"></a>
<span class="sourceLineNo">106</span> * chronological order.<a name="line.106"></a>
<span class="sourceLineNo">107</span> *<a name="line.107"></a>
<span class="sourceLineNo">108</span> * &lt;p&gt;&lt;b&gt;Warning:&lt;/b&gt; instances of type {@code Multimap} may not implement<a name="line.108"></a>
<span class="sourceLineNo">109</span> * {@link Object#equals} in the way you expect (multimaps containing the same<a name="line.109"></a>
<span class="sourceLineNo">110</span> * key-value pairs, even in the same order, may or may not be equal). The<a name="line.110"></a>
<span class="sourceLineNo">111</span> * recommended subinterfaces provide a much stronger guarantee.<a name="line.111"></a>
<span class="sourceLineNo">112</span> *<a name="line.112"></a>
<span class="sourceLineNo">113</span> * &lt;h3&gt;Comparison to a map of collections&lt;/h3&gt;<a name="line.113"></a>
<span class="sourceLineNo">114</span> *<a name="line.114"></a>
<span class="sourceLineNo">115</span> * &lt;p&gt;Multimaps are commonly used in places where a {@code Map&lt;K,<a name="line.115"></a>
<span class="sourceLineNo">116</span> * Collection&lt;V&gt;&gt;} would otherwise have appeared. The differences include:<a name="line.116"></a>
<span class="sourceLineNo">117</span> *<a name="line.117"></a>
<span class="sourceLineNo">118</span> * &lt;ul&gt;<a name="line.118"></a>
<span class="sourceLineNo">119</span> * &lt;li&gt;There is no need to populate an empty collection before adding an entry<a name="line.119"></a>
<span class="sourceLineNo">120</span> *     with {@link #put put}.<a name="line.120"></a>
<span class="sourceLineNo">121</span> * &lt;li&gt;{@code get} never returns {@code null}, only an empty collection.<a name="line.121"></a>
<span class="sourceLineNo">122</span> * &lt;li&gt;A key contained in the multimap always maps to at least one value. Any<a name="line.122"></a>
<span class="sourceLineNo">123</span> *     operation that causes a key to have zero associated values has the effect<a name="line.123"></a>
<span class="sourceLineNo">124</span> *     of &lt;i&gt;removing&lt;/i&gt; that key from the multimap.<a name="line.124"></a>
<span class="sourceLineNo">125</span> * &lt;li&gt;The total entry count is available as {@link #size}.<a name="line.125"></a>
<span class="sourceLineNo">126</span> * &lt;li&gt;Many complex operations become easier; for example, {@code<a name="line.126"></a>
<span class="sourceLineNo">127</span> *     Collections.min(multimap.values())} finds the smallest value across all<a name="line.127"></a>
<span class="sourceLineNo">128</span> *     keys.<a name="line.128"></a>
<span class="sourceLineNo">129</span> * &lt;/ul&gt;<a name="line.129"></a>
<span class="sourceLineNo">130</span> *<a name="line.130"></a>
<span class="sourceLineNo">131</span> * &lt;h3&gt;Implementations&lt;/h3&gt;<a name="line.131"></a>
<span class="sourceLineNo">132</span> *<a name="line.132"></a>
<span class="sourceLineNo">133</span> * &lt;p&gt;As always, prefer the immutable implementations, {@link<a name="line.133"></a>
<span class="sourceLineNo">134</span> * ImmutableListMultimap} and {@link ImmutableSetMultimap}. General-purpose<a name="line.134"></a>
<span class="sourceLineNo">135</span> * mutable implementations are listed above under "All Known Implementing<a name="line.135"></a>
<span class="sourceLineNo">136</span> * Classes". You can also create a &lt;i&gt;custom&lt;/i&gt; multimap, backed by any {@code<a name="line.136"></a>
<span class="sourceLineNo">137</span> * Map} and {@link Collection} types, using the {@link Multimaps#newMultimap<a name="line.137"></a>
<span class="sourceLineNo">138</span> * Multimaps.newMultimap} family of methods. Finally, another popular way to<a name="line.138"></a>
<span class="sourceLineNo">139</span> * obtain a multimap is using {@link Multimaps#index Multimaps.index}. See<a name="line.139"></a>
<span class="sourceLineNo">140</span> * the {@link Multimaps} class for these and other static utilities related<a name="line.140"></a>
<span class="sourceLineNo">141</span> * to multimaps.<a name="line.141"></a>
<span class="sourceLineNo">142</span> *<a name="line.142"></a>
<span class="sourceLineNo">143</span> * &lt;h3&gt;Other Notes&lt;/h3&gt;<a name="line.143"></a>
<span class="sourceLineNo">144</span> *<a name="line.144"></a>
<span class="sourceLineNo">145</span> * &lt;p&gt;All methods that modify the multimap are optional. The view collections<a name="line.145"></a>
<span class="sourceLineNo">146</span> * returned by the multimap may or may not be modifiable. Any modification<a name="line.146"></a>
<span class="sourceLineNo">147</span> * method that is not supported will throw {@link<a name="line.147"></a>
<span class="sourceLineNo">148</span> * UnsupportedOperationException}.<a name="line.148"></a>
<span class="sourceLineNo">149</span> *<a name="line.149"></a>
<span class="sourceLineNo">150</span> * &lt;p&gt;See the Guava User Guide article on &lt;a href=<a name="line.150"></a>
<span class="sourceLineNo">151</span> * "http://code.google.com/p/guava-libraries/wiki/NewCollectionTypesExplained#Multimap"&gt;<a name="line.151"></a>
<span class="sourceLineNo">152</span> * {@code Multimap}&lt;/a&gt;.<a name="line.152"></a>
<span class="sourceLineNo">153</span> *<a name="line.153"></a>
<span class="sourceLineNo">154</span> * @author Jared Levy<a name="line.154"></a>
<span class="sourceLineNo">155</span> * @since 2.0 (imported from Google Collections Library)<a name="line.155"></a>
<span class="sourceLineNo">156</span> */<a name="line.156"></a>
<span class="sourceLineNo">157</span>@GwtCompatible<a name="line.157"></a>
<span class="sourceLineNo">158</span>public interface Multimap&lt;K, V&gt; {<a name="line.158"></a>
<span class="sourceLineNo">159</span>  // Query Operations<a name="line.159"></a>
<span class="sourceLineNo">160</span><a name="line.160"></a>
<span class="sourceLineNo">161</span>  /** Returns the number of key-value pairs in the multimap. */<a name="line.161"></a>
<span class="sourceLineNo">162</span>  int size();<a name="line.162"></a>
<span class="sourceLineNo">163</span><a name="line.163"></a>
<span class="sourceLineNo">164</span>  /** Returns {@code true} if the multimap contains no key-value pairs. */<a name="line.164"></a>
<span class="sourceLineNo">165</span>  boolean isEmpty();<a name="line.165"></a>
<span class="sourceLineNo">166</span><a name="line.166"></a>
<span class="sourceLineNo">167</span>  /**<a name="line.167"></a>
<span class="sourceLineNo">168</span>   * Returns {@code true} if the multimap contains any values for the specified<a name="line.168"></a>
<span class="sourceLineNo">169</span>   * key.<a name="line.169"></a>
<span class="sourceLineNo">170</span>   *<a name="line.170"></a>
<span class="sourceLineNo">171</span>   * @param key key to search for in multimap<a name="line.171"></a>
<span class="sourceLineNo">172</span>   */<a name="line.172"></a>
<span class="sourceLineNo">173</span>  boolean containsKey(@Nullable Object key);<a name="line.173"></a>
<span class="sourceLineNo">174</span><a name="line.174"></a>
<span class="sourceLineNo">175</span>  /**<a name="line.175"></a>
<span class="sourceLineNo">176</span>   * Returns {@code true} if the multimap contains the specified value for any<a name="line.176"></a>
<span class="sourceLineNo">177</span>   * key.<a name="line.177"></a>
<span class="sourceLineNo">178</span>   *<a name="line.178"></a>
<span class="sourceLineNo">179</span>   * @param value value to search for in multimap<a name="line.179"></a>
<span class="sourceLineNo">180</span>   */<a name="line.180"></a>
<span class="sourceLineNo">181</span>  boolean containsValue(@Nullable Object value);<a name="line.181"></a>
<span class="sourceLineNo">182</span><a name="line.182"></a>
<span class="sourceLineNo">183</span>  /**<a name="line.183"></a>
<span class="sourceLineNo">184</span>   * Returns {@code true} if the multimap contains the specified key-value pair.<a name="line.184"></a>
<span class="sourceLineNo">185</span>   *<a name="line.185"></a>
<span class="sourceLineNo">186</span>   * @param key key to search for in multimap<a name="line.186"></a>
<span class="sourceLineNo">187</span>   * @param value value to search for in multimap<a name="line.187"></a>
<span class="sourceLineNo">188</span>   */<a name="line.188"></a>
<span class="sourceLineNo">189</span>  boolean containsEntry(@Nullable Object key, @Nullable Object value);<a name="line.189"></a>
<span class="sourceLineNo">190</span><a name="line.190"></a>
<span class="sourceLineNo">191</span>  // Modification Operations<a name="line.191"></a>
<span class="sourceLineNo">192</span><a name="line.192"></a>
<span class="sourceLineNo">193</span>  /**<a name="line.193"></a>
<span class="sourceLineNo">194</span>   * Stores a key-value pair in the multimap.<a name="line.194"></a>
<span class="sourceLineNo">195</span>   *<a name="line.195"></a>
<span class="sourceLineNo">196</span>   * &lt;p&gt;Some multimap implementations allow duplicate key-value pairs, in which<a name="line.196"></a>
<span class="sourceLineNo">197</span>   * case {@code put} always adds a new key-value pair and increases the<a name="line.197"></a>
<span class="sourceLineNo">198</span>   * multimap size by 1. Other implementations prohibit duplicates, and storing<a name="line.198"></a>
<span class="sourceLineNo">199</span>   * a key-value pair that's already in the multimap has no effect.<a name="line.199"></a>
<span class="sourceLineNo">200</span>   *<a name="line.200"></a>
<span class="sourceLineNo">201</span>   * @param key key to store in the multimap<a name="line.201"></a>
<span class="sourceLineNo">202</span>   * @param value value to store in the multimap<a name="line.202"></a>
<span class="sourceLineNo">203</span>   * @return {@code true} if the method increased the size of the multimap, or<a name="line.203"></a>
<span class="sourceLineNo">204</span>   *     {@code false} if the multimap already contained the key-value pair and<a name="line.204"></a>
<span class="sourceLineNo">205</span>   *     doesn't allow duplicates<a name="line.205"></a>
<span class="sourceLineNo">206</span>   */<a name="line.206"></a>
<span class="sourceLineNo">207</span>  boolean put(@Nullable K key, @Nullable V value);<a name="line.207"></a>
<span class="sourceLineNo">208</span><a name="line.208"></a>
<span class="sourceLineNo">209</span>  /**<a name="line.209"></a>
<span class="sourceLineNo">210</span>   * Removes a single key-value pair from the multimap.<a name="line.210"></a>
<span class="sourceLineNo">211</span>   *<a name="line.211"></a>
<span class="sourceLineNo">212</span>   * @param key key of entry to remove from the multimap<a name="line.212"></a>
<span class="sourceLineNo">213</span>   * @param value value of entry to remove the multimap<a name="line.213"></a>
<span class="sourceLineNo">214</span>   * @return {@code true} if the multimap changed<a name="line.214"></a>
<span class="sourceLineNo">215</span>   */<a name="line.215"></a>
<span class="sourceLineNo">216</span>  boolean remove(@Nullable Object key, @Nullable Object value);<a name="line.216"></a>
<span class="sourceLineNo">217</span><a name="line.217"></a>
<span class="sourceLineNo">218</span>  // Bulk Operations<a name="line.218"></a>
<span class="sourceLineNo">219</span><a name="line.219"></a>
<span class="sourceLineNo">220</span>  /**<a name="line.220"></a>
<span class="sourceLineNo">221</span>   * Stores a collection of values with the same key.<a name="line.221"></a>
<span class="sourceLineNo">222</span>   *<a name="line.222"></a>
<span class="sourceLineNo">223</span>   * @param key key to store in the multimap<a name="line.223"></a>
<span class="sourceLineNo">224</span>   * @param values values to store in the multimap<a name="line.224"></a>
<span class="sourceLineNo">225</span>   * @return {@code true} if the multimap changed<a name="line.225"></a>
<span class="sourceLineNo">226</span>   */<a name="line.226"></a>
<span class="sourceLineNo">227</span>  boolean putAll(@Nullable K key, Iterable&lt;? extends V&gt; values);<a name="line.227"></a>
<span class="sourceLineNo">228</span><a name="line.228"></a>
<span class="sourceLineNo">229</span>  /**<a name="line.229"></a>
<span class="sourceLineNo">230</span>   * Copies all of another multimap's key-value pairs into this multimap. The<a name="line.230"></a>
<span class="sourceLineNo">231</span>   * order in which the mappings are added is determined by<a name="line.231"></a>
<span class="sourceLineNo">232</span>   * {@code multimap.entries()}.<a name="line.232"></a>
<span class="sourceLineNo">233</span>   *<a name="line.233"></a>
<span class="sourceLineNo">234</span>   * @param multimap mappings to store in this multimap<a name="line.234"></a>
<span class="sourceLineNo">235</span>   * @return {@code true} if the multimap changed<a name="line.235"></a>
<span class="sourceLineNo">236</span>   */<a name="line.236"></a>
<span class="sourceLineNo">237</span>  boolean putAll(Multimap&lt;? extends K, ? extends V&gt; multimap);<a name="line.237"></a>
<span class="sourceLineNo">238</span><a name="line.238"></a>
<span class="sourceLineNo">239</span>  /**<a name="line.239"></a>
<span class="sourceLineNo">240</span>   * Stores a collection of values with the same key, replacing any existing<a name="line.240"></a>
<span class="sourceLineNo">241</span>   * values for that key.<a name="line.241"></a>
<span class="sourceLineNo">242</span>   *<a name="line.242"></a>
<span class="sourceLineNo">243</span>   * @param key key to store in the multimap<a name="line.243"></a>
<span class="sourceLineNo">244</span>   * @param values values to store in the multimap<a name="line.244"></a>
<span class="sourceLineNo">245</span>   * @return the collection of replaced values, or an empty collection if no<a name="line.245"></a>
<span class="sourceLineNo">246</span>   *     values were previously associated with the key. The collection<a name="line.246"></a>
<span class="sourceLineNo">247</span>   *     &lt;i&gt;may&lt;/i&gt; be modifiable, but updating it will have no effect on the<a name="line.247"></a>
<span class="sourceLineNo">248</span>   *     multimap.<a name="line.248"></a>
<span class="sourceLineNo">249</span>   */<a name="line.249"></a>
<span class="sourceLineNo">250</span>  Collection&lt;V&gt; replaceValues(@Nullable K key, Iterable&lt;? extends V&gt; values);<a name="line.250"></a>
<span class="sourceLineNo">251</span><a name="line.251"></a>
<span class="sourceLineNo">252</span>  /**<a name="line.252"></a>
<span class="sourceLineNo">253</span>   * Removes all values associated with a given key.<a name="line.253"></a>
<span class="sourceLineNo">254</span>   *<a name="line.254"></a>
<span class="sourceLineNo">255</span>   * @param key key of entries to remove from the multimap<a name="line.255"></a>
<span class="sourceLineNo">256</span>   * @return the collection of removed values, or an empty collection if no<a name="line.256"></a>
<span class="sourceLineNo">257</span>   *     values were associated with the provided key. The collection<a name="line.257"></a>
<span class="sourceLineNo">258</span>   *     &lt;i&gt;may&lt;/i&gt; be modifiable, but updating it will have no effect on the<a name="line.258"></a>
<span class="sourceLineNo">259</span>   *     multimap.<a name="line.259"></a>
<span class="sourceLineNo">260</span>   */<a name="line.260"></a>
<span class="sourceLineNo">261</span>  Collection&lt;V&gt; removeAll(@Nullable Object key);<a name="line.261"></a>
<span class="sourceLineNo">262</span><a name="line.262"></a>
<span class="sourceLineNo">263</span>  /**<a name="line.263"></a>
<span class="sourceLineNo">264</span>   * Removes all key-value pairs from the multimap.<a name="line.264"></a>
<span class="sourceLineNo">265</span>   */<a name="line.265"></a>
<span class="sourceLineNo">266</span>  void clear();<a name="line.266"></a>
<span class="sourceLineNo">267</span><a name="line.267"></a>
<span class="sourceLineNo">268</span>  // Views<a name="line.268"></a>
<span class="sourceLineNo">269</span><a name="line.269"></a>
<span class="sourceLineNo">270</span>  /**<a name="line.270"></a>
<span class="sourceLineNo">271</span>   * Returns a collection view containing the values associated with {@code key}<a name="line.271"></a>
<span class="sourceLineNo">272</span>   * in this multimap, if any. Note that even when ({@code containsKey(key)} is<a name="line.272"></a>
<span class="sourceLineNo">273</span>   * false, {@code get(key)} still returns an empty collection, not {@code<a name="line.273"></a>
<span class="sourceLineNo">274</span>   * null}.<a name="line.274"></a>
<span class="sourceLineNo">275</span>   *<a name="line.275"></a>
<span class="sourceLineNo">276</span>   * &lt;p&gt;Changes to the returned collection will update the underlying multimap,<a name="line.276"></a>
<span class="sourceLineNo">277</span>   * and vice versa.<a name="line.277"></a>
<span class="sourceLineNo">278</span>   *<a name="line.278"></a>
<span class="sourceLineNo">279</span>   * @param key key to search for in multimap<a name="line.279"></a>
<span class="sourceLineNo">280</span>   * @return a view collection containing the zero or more values that the key<a name="line.280"></a>
<span class="sourceLineNo">281</span>   *     maps to<a name="line.281"></a>
<span class="sourceLineNo">282</span>   */<a name="line.282"></a>
<span class="sourceLineNo">283</span>  Collection&lt;V&gt; get(@Nullable K key);<a name="line.283"></a>
<span class="sourceLineNo">284</span><a name="line.284"></a>
<span class="sourceLineNo">285</span>  /**<a name="line.285"></a>
<span class="sourceLineNo">286</span>   * Returns the set of all keys, each appearing once in the returned set.<a name="line.286"></a>
<span class="sourceLineNo">287</span>   * Changes to the returned set will update the underlying multimap, and vice<a name="line.287"></a>
<span class="sourceLineNo">288</span>   * versa.<a name="line.288"></a>
<span class="sourceLineNo">289</span>   *<a name="line.289"></a>
<span class="sourceLineNo">290</span>   * @return the collection of distinct keys<a name="line.290"></a>
<span class="sourceLineNo">291</span>   */<a name="line.291"></a>
<span class="sourceLineNo">292</span>  Set&lt;K&gt; keySet();<a name="line.292"></a>
<span class="sourceLineNo">293</span><a name="line.293"></a>
<span class="sourceLineNo">294</span>  /**<a name="line.294"></a>
<span class="sourceLineNo">295</span>   * Returns a collection, which may contain duplicates, of all keys. The number<a name="line.295"></a>
<span class="sourceLineNo">296</span>   * of times of key appears in the returned multiset equals the number of<a name="line.296"></a>
<span class="sourceLineNo">297</span>   * mappings the key has in the multimap. Changes to the returned multiset will<a name="line.297"></a>
<span class="sourceLineNo">298</span>   * update the underlying multimap, and vice versa.<a name="line.298"></a>
<span class="sourceLineNo">299</span>   *<a name="line.299"></a>
<span class="sourceLineNo">300</span>   * @return a multiset with keys corresponding to the distinct keys of the<a name="line.300"></a>
<span class="sourceLineNo">301</span>   *     multimap and frequencies corresponding to the number of values that<a name="line.301"></a>
<span class="sourceLineNo">302</span>   *     each key maps to<a name="line.302"></a>
<span class="sourceLineNo">303</span>   */<a name="line.303"></a>
<span class="sourceLineNo">304</span>  Multiset&lt;K&gt; keys();<a name="line.304"></a>
<span class="sourceLineNo">305</span><a name="line.305"></a>
<span class="sourceLineNo">306</span>  /**<a name="line.306"></a>
<span class="sourceLineNo">307</span>   * Returns a collection of all values in the multimap. Changes to the returned<a name="line.307"></a>
<span class="sourceLineNo">308</span>   * collection will update the underlying multimap, and vice versa.<a name="line.308"></a>
<span class="sourceLineNo">309</span>   *<a name="line.309"></a>
<span class="sourceLineNo">310</span>   * @return collection of values, which may include the same value multiple<a name="line.310"></a>
<span class="sourceLineNo">311</span>   *     times if it occurs in multiple mappings<a name="line.311"></a>
<span class="sourceLineNo">312</span>   */<a name="line.312"></a>
<span class="sourceLineNo">313</span>  Collection&lt;V&gt; values();<a name="line.313"></a>
<span class="sourceLineNo">314</span><a name="line.314"></a>
<span class="sourceLineNo">315</span>  /**<a name="line.315"></a>
<span class="sourceLineNo">316</span>   * Returns a collection of all key-value pairs. Changes to the returned<a name="line.316"></a>
<span class="sourceLineNo">317</span>   * collection will update the underlying multimap, and vice versa. The entries<a name="line.317"></a>
<span class="sourceLineNo">318</span>   * collection does not support the {@code add} or {@code addAll} operations.<a name="line.318"></a>
<span class="sourceLineNo">319</span>   *<a name="line.319"></a>
<span class="sourceLineNo">320</span>   * @return collection of map entries consisting of key-value pairs<a name="line.320"></a>
<span class="sourceLineNo">321</span>   */<a name="line.321"></a>
<span class="sourceLineNo">322</span>  Collection&lt;Map.Entry&lt;K, V&gt;&gt; entries();<a name="line.322"></a>
<span class="sourceLineNo">323</span><a name="line.323"></a>
<span class="sourceLineNo">324</span>  /**<a name="line.324"></a>
<span class="sourceLineNo">325</span>   * Returns a map view that associates each key with the corresponding values<a name="line.325"></a>
<span class="sourceLineNo">326</span>   * in the multimap. Changes to the returned map, such as element removal, will<a name="line.326"></a>
<span class="sourceLineNo">327</span>   * update the underlying multimap. The map does not support {@code setValue()}<a name="line.327"></a>
<span class="sourceLineNo">328</span>   * on its entries, {@code put}, or {@code putAll}.<a name="line.328"></a>
<span class="sourceLineNo">329</span>   *<a name="line.329"></a>
<span class="sourceLineNo">330</span>   * &lt;p&gt;When passed a key that is present in the map, {@code<a name="line.330"></a>
<span class="sourceLineNo">331</span>   * asMap().get(Object)} has the same behavior as {@link #get}, returning a<a name="line.331"></a>
<span class="sourceLineNo">332</span>   * live collection. When passed a key that is not present, however, {@code<a name="line.332"></a>
<span class="sourceLineNo">333</span>   * asMap().get(Object)} returns {@code null} instead of an empty collection.<a name="line.333"></a>
<span class="sourceLineNo">334</span>   *<a name="line.334"></a>
<span class="sourceLineNo">335</span>   * @return a map view from a key to its collection of values<a name="line.335"></a>
<span class="sourceLineNo">336</span>   */<a name="line.336"></a>
<span class="sourceLineNo">337</span>  Map&lt;K, Collection&lt;V&gt;&gt; asMap();<a name="line.337"></a>
<span class="sourceLineNo">338</span><a name="line.338"></a>
<span class="sourceLineNo">339</span>  // Comparison and hashing<a name="line.339"></a>
<span class="sourceLineNo">340</span><a name="line.340"></a>
<span class="sourceLineNo">341</span>  /**<a name="line.341"></a>
<span class="sourceLineNo">342</span>   * Compares the specified object with this multimap for equality. Two<a name="line.342"></a>
<span class="sourceLineNo">343</span>   * multimaps are equal when their map views, as returned by {@link #asMap},<a name="line.343"></a>
<span class="sourceLineNo">344</span>   * are also equal.<a name="line.344"></a>
<span class="sourceLineNo">345</span>   *<a name="line.345"></a>
<span class="sourceLineNo">346</span>   * &lt;p&gt;In general, two multimaps with identical key-value mappings may or may<a name="line.346"></a>
<span class="sourceLineNo">347</span>   * not be equal, depending on the implementation. For example, two<a name="line.347"></a>
<span class="sourceLineNo">348</span>   * {@link SetMultimap} instances with the same key-value mappings are equal,<a name="line.348"></a>
<span class="sourceLineNo">349</span>   * but equality of two {@link ListMultimap} instances depends on the ordering<a name="line.349"></a>
<span class="sourceLineNo">350</span>   * of the values for each key.<a name="line.350"></a>
<span class="sourceLineNo">351</span>   *<a name="line.351"></a>
<span class="sourceLineNo">352</span>   * &lt;p&gt;A non-empty {@link SetMultimap} cannot be equal to a non-empty<a name="line.352"></a>
<span class="sourceLineNo">353</span>   * {@link ListMultimap}, since their {@link #asMap} views contain unequal<a name="line.353"></a>
<span class="sourceLineNo">354</span>   * collections as values. However, any two empty multimaps are equal, because<a name="line.354"></a>
<span class="sourceLineNo">355</span>   * they both have empty {@link #asMap} views.<a name="line.355"></a>
<span class="sourceLineNo">356</span>   */<a name="line.356"></a>
<span class="sourceLineNo">357</span>  @Override<a name="line.357"></a>
<span class="sourceLineNo">358</span>  boolean equals(@Nullable Object obj);<a name="line.358"></a>
<span class="sourceLineNo">359</span><a name="line.359"></a>
<span class="sourceLineNo">360</span>  /**<a name="line.360"></a>
<span class="sourceLineNo">361</span>   * Returns the hash code for this multimap.<a name="line.361"></a>
<span class="sourceLineNo">362</span>   *<a name="line.362"></a>
<span class="sourceLineNo">363</span>   * &lt;p&gt;The hash code of a multimap is defined as the hash code of the map view,<a name="line.363"></a>
<span class="sourceLineNo">364</span>   * as returned by {@link Multimap#asMap}.<a name="line.364"></a>
<span class="sourceLineNo">365</span>   */<a name="line.365"></a>
<span class="sourceLineNo">366</span>  @Override<a name="line.366"></a>
<span class="sourceLineNo">367</span>  int hashCode();<a name="line.367"></a>
<span class="sourceLineNo">368</span>}<a name="line.368"></a>




























































</pre>
</div>
</body>
</html>
